lib: add some missing (out) annotations
authorFelix Krull <f_krull@gmx.de>
Sat, 18 May 2019 14:12:30 +0000 (16:12 +0200)
committerAtomic Bot <atomic-devel@projectatomic.io>
Sun, 19 May 2019 14:50:08 +0000 (14:50 +0000)
Closes: #1861
Approved by: cgwalters

src/libostree/ostree-mutable-tree.c
src/libostree/ostree-repo-file.c
src/libostree/ostree-repo.c

index a213fd4a76cd49fcc39c4265f5e90e4c1c48325c..8509d1566d6b75d65ff5e2faef58ab742f3969e5 100644 (file)
@@ -401,6 +401,14 @@ ostree_mutable_tree_ensure_dir (OstreeMutableTree *self,
   return TRUE;
 }
 
+/**
+ * ostree_mutable_tree_lookup:
+ * @self: Tree
+ * @name: name
+ * @out_file_checksum: (out) (transfer full): checksum
+ * @out_subdir: (out) (transfer full): subdirectory
+ * @error: a #GError
+ */
 gboolean
 ostree_mutable_tree_lookup (OstreeMutableTree   *self,
                             const char          *name,
index 740b4624872e476565a45e204e02daa3889f3057..7ad115296cb499b17731fe9ea2a02941d57ff3e9 100644 (file)
@@ -292,6 +292,13 @@ ostree_repo_file_ensure_resolved (OstreeRepoFile  *self,
   return TRUE;
 }
 
+/**
+ * ostree_repo_file_get_xattrs:
+ * @self: #OstreeRepoFile
+ * @out_xattrs: (out) (optional): the extended attributes
+ * @cancellable: Cancellable
+ * @error: Error
+ */
 gboolean
 ostree_repo_file_get_xattrs (OstreeRepoFile  *self,
                              GVariant       **out_xattrs,
@@ -724,6 +731,13 @@ query_child_info_dir (OstreeRepo               *repo,
   return TRUE;
 }
 
+/**
+ * ostree_repo_file_tree_find_child:
+ * @self: #OstreeRepoFile
+ * @name: name of the child
+ * @is_dir: (out caller-allocates):
+ * @out_container: (out):
+ */
 int
 ostree_repo_file_tree_find_child  (OstreeRepoFile  *self,
                                     const char      *name,
@@ -769,6 +783,16 @@ ostree_repo_file_tree_find_child  (OstreeRepoFile  *self,
   return i;
 }
 
+/**
+ * ostree_repo_file_tree_query_child:
+ * @self: #OstreeRepoFile
+ * @n:
+ * @attributes:
+ * @flags:
+ * @out_info: (out):
+ * @cancellable: Cancellable
+ * @error: Error
+ */
 gboolean
 ostree_repo_file_tree_query_child (OstreeRepoFile  *self,
                                     int              n,
index 3238e4291c17286ce548902c871bfeaa9666db1c..da128c6a9e33ee97ee58242c6d4ac227be998acb 100644 (file)
@@ -2048,9 +2048,9 @@ ostree_repo_remote_get_gpg_verify_summary (OstreeRepo  *self,
  * ostree_repo_remote_gpg_import:
  * @self: Self
  * @name: name of a remote
- * @source_stream: (allow-none): a #GInputStream, or %NULL
- * @key_ids: (array zero-terminated=1) (element-type utf8) (allow-none): a %NULL-terminated array of GPG key IDs, or %NULL
- * @out_imported: (allow-none): return location for the number of imported
+ * @source_stream: (nullable): a #GInputStream, or %NULL
+ * @key_ids: (array zero-terminated=1) (element-type utf8) (nullable): a %NULL-terminated array of GPG key IDs, or %NULL
+ * @out_imported: (out) (optional): return location for the number of imported
  *                              keys, or %NULL
  * @cancellable: a #GCancellable
  * @error: a #GError
@@ -2385,6 +2385,12 @@ ostree_repo_mode_to_string (OstreeRepoMode   mode,
   return TRUE;
 }
 
+/**
+ * ostree_repo_mode_from_string:
+ * @mode: a repo mode as a string
+ * @out_mode: (out): the corresponding #OstreeRepoMode
+ * @error: a #GError if the string is not a valid mode
+ */
 gboolean
 ostree_repo_mode_from_string (const char      *mode,
                               OstreeRepoMode  *out_mode,